Skip to content

Conversation

anskhanson
Copy link
Collaborator

Checklist:

  • Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • Bench test new/modified APIs by using and modifying the code in the example for the API method
  • Add new classes to rst files, located at: \doc\source\api
  • Generate documentation
  • Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • Check that test code coverage is at least 80% when Sherlock is running

@github-actions github-actions bot added testing Anything related to tests documentation Improvements or additions to documentation labels Oct 30, 2024
@anskhanson anskhanson closed this Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing Anything related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants